<html>
<head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
    <title>spawn (2 of 7 overloads)</title>
    <link rel="stylesheet" href="../../../boostbook.css" type="text/css">
    <meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
    <link rel="home" href="../../../index.html" title="Asio">
    <link rel="up" href="../spawn.html" title="spawn">
    <link rel="prev" href="overload1.html" title="spawn (1 of 7 overloads)">
    <link rel="next" href="overload3.html" title="spawn (3 of 7 overloads)">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
    <tr>
        <td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../asio.png"></td>
    </tr>
</table>
<hr>
<div class="spirit-nav">
    <a accesskey="p" href="overload1.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u"
                                                                                          href="../spawn.html"><img
        src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png"
                                                                                            alt="Home"></a><a
        accesskey="n" href="overload3.html"><img src="../../../next.png" alt="Next"></a>
</div>
<div class="section">
    <div class="titlepage">
        <div>
            <div><h4 class="title">
                <a name="asio.reference.spawn.overload2"></a><a class="link" href="overload2.html"
                                                                title="spawn (2 of 7 overloads)">spawn (2 of 7
                overloads)</a>
            </h4></div>
        </div>
    </div>
    <p>
        Start a new stackful coroutine, calling the specified handler when it completes.
    </p>
    <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
    <span class="keyword">typename</span> <a class="link" href="../Handler.html" title="Handlers">Handler</a><span
                class="special">,</span>
    <span class="keyword">typename</span> <span class="identifier">Function</span><span class="special">&gt;</span>
<span class="keyword">void</span> <span class="identifier">spawn</span><span class="special">(</span>
    <span class="identifier">Handler</span> <span class="special">&amp;&amp;</span> <span
                class="identifier">handler</span><span class="special">,</span>
    <span class="identifier">Function</span> <span class="special">&amp;&amp;</span> <span
                class="identifier">function</span><span class="special">,</span>
    <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span
                class="identifier">coroutines</span><span class="special">::</span><span
                class="identifier">attributes</span> <span class="special">&amp;</span> <span class="identifier">attributes</span> <span
                class="special">=</span> <span class="identifier">boost</span><span class="special">::</span><span
                class="identifier">coroutines</span><span class="special">::</span><span
                class="identifier">attributes</span><span class="special">(),</span>
    <span class="keyword">typename</span> <span class="identifier">constraint</span><span
                class="special">&lt;</span> <span class="special">!</span><span
                class="identifier">is_executor</span><span class="special">&lt;</span> <span
                class="keyword">typename</span> <span class="identifier">decay</span><span
                class="special">&lt;</span> <span class="identifier">Handler</span> <span
                class="special">&gt;::</span><span class="identifier">type</span> <span
                class="special">&gt;::</span><span class="identifier">value</span> <span
                class="special">&amp;&amp;!</span><span class="identifier">execution</span><span
                class="special">::</span><span class="identifier">is_executor</span><span
                class="special">&lt;</span> <span class="keyword">typename</span> <span
                class="identifier">decay</span><span class="special">&lt;</span> <span class="identifier">Handler</span> <span
                class="special">&gt;::</span><span class="identifier">type</span> <span
                class="special">&gt;::</span><span class="identifier">value</span> <span
                class="special">&amp;&amp;!</span><span class="identifier">is_convertible</span><span class="special">&lt;</span> <span
                class="identifier">Handler</span> <span class="special">&amp;,</span> <span class="identifier">execution_context</span> <span
                class="special">&amp;</span> <span class="special">&gt;::</span><span
                class="identifier">value</span> <span class="special">&gt;::</span><span class="identifier">type</span>  <span
                class="special">=</span> <span class="number">0</span><span class="special">);</span>
</pre>
    <p>
        This function is used to launch a new coroutine.
    </p>
    <h6>
        <a name="asio.reference.spawn.overload2.h0"></a>
        <span><a name="asio.reference.spawn.overload2.parameters"></a></span><a class="link"
                                                                                href="overload2.html#asio.reference.spawn.overload2.parameters">Parameters</a>
    </h6>
    <div class="variablelist">
        <p class="title"><b></b></p>
        <dl>
            <dt><span class="term">handler</span></dt>
            <dd>
                <p>
                    A handler to be called when the coroutine exits. More importantly,
                    the handler provides an execution context (via the the handler invocation
                    hook) for the coroutine. The handler must have the signature:
                </p>
                <pre class="programlisting"><span class="keyword">void</span> <span
                        class="identifier">handler</span><span class="special">();</span>
</pre>
            </dd>
            <dt><span class="term">function</span></dt>
            <dd>
                <p>
                    The coroutine function. The function must have the signature:
                </p>
                <pre class="programlisting"><span class="keyword">void</span> <span
                        class="identifier">function</span><span class="special">(</span><span class="identifier">basic_yield_context</span><span
                        class="special">&lt;</span><span class="identifier">Handler</span><span
                        class="special">&gt;</span> <span class="identifier">yield</span><span class="special">);</span>
</pre>
            </dd>
            <dt><span class="term">attributes</span></dt>
            <dd><p>
                Boost.Coroutine attributes used to customise the coroutine.
            </p></dd>
        </dl>
    </div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%">
    <tr>
        <td align="left"></td>
        <td align="right">
            <div class="copyright-footer">Copyright © 2003-2022 Christopher M. Kohlhoff<p>
                Distributed under the Boost Software License, Version 1.0. (See accompanying
                file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
            </p>
            </div>
        </td>
    </tr>
</table>
<hr>
<div class="spirit-nav">
    <a accesskey="p" href="overload1.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u"
                                                                                          href="../spawn.html"><img
        src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png"
                                                                                            alt="Home"></a><a
        accesskey="n" href="overload3.html"><img src="../../../next.png" alt="Next"></a>
</div>
</body>
</html>
